FoxitPDFSDKPython2.ReadingBookmark类 参考
类 FoxitPDFSDKPython2.ReadingBookmark 继承关系图:
Public 成员函数 | |
| def | ReadingBookmark (other) |
| 构造函数，使用另一个阅读书签对象。 更多... | |
| def | GetDateTime (is_creation_date) |
| 获取日期时间信息。 更多... | |
| def | GetPageIndex () |
| 获取目标页面的索引。 更多... | |
| def | GetTitle () |
| 获取标题。 更多... | |
| def | IsEmpty () |
| 检查当前对象是否为空。 更多... | |
| def | SetDateTime (date_time, is_creation_date) |
| 设置日期时间信息。 更多... | |
| def | SetPageIndex (index) |
| 设置目标页面的索引。 更多... | |
| def | SetTitle (title) |
| 设置标题。 更多... | |
详细描述
阅读书签不是PDF书签，换句话说，它不是PDF大纲。 它是应用程序级别的书签。它存储在目录的元数据（XML格式）中。它允许 用户根据阅读偏好添加或删除阅读书签，并通过选择一个阅读书签 轻松导航到PDF页面。
为了检索阅读书签，可以调用函数 FoxitPDFSDKPython2.PDFDoc.GetReadingBookmarkCount 来 计算阅读书签的数量，可以调用函数 FoxitPDFSDKPython2.PDFDoc.GetReadingBookmark 来 通过索引获取阅读书签。
此类提供了几个函数来获取/设置阅读书签的属性，例如标题、 目标页面索引以及创建/修改日期时间。
- 参见
- PDFDoc
构造及析构函数说明
◆ ReadingBookmark()
| def FoxitPDFSDKPython2.ReadingBookmark.ReadingBookmark | ( | other | ) |
构造函数，使用另一个阅读书签对象。
- 参数
-
[in] other 另一个阅读书签对象。
成员函数说明
◆ GetDateTime()
| def FoxitPDFSDKPython2.ReadingBookmark.GetDateTime | ( | is_creation_date | ) |
获取日期时间信息。
- 参数
-
[in] is_creation_date true 表示获取创建日期时间信息， false 表示获取最后修改日期时间信息。
- 返回
- 指定的日期和时间。如果找不到指定的日期和时间属性， 此函数将返回所有值为0的日期和时间对象。
◆ GetPageIndex()
| def FoxitPDFSDKPython2.ReadingBookmark.GetPageIndex | ( | ) |
获取目标页面的索引。
- 返回
- 页面索引，从0开始。如果找不到页面索引属性，此函数将返回-1。
◆ GetTitle()
| def FoxitPDFSDKPython2.ReadingBookmark.GetTitle | ( | ) |
获取标题。
- 返回
- 标题字符串。如果找不到标题属性，此函数将返回空字符串。
◆ IsEmpty()
| def FoxitPDFSDKPython2.ReadingBookmark.IsEmpty | ( | ) |
检查当前对象是否为空。
当前对象为空时，表示当前对象无用。
- 返回
- true 表示当前对象为空，false 表示不为空。
◆ SetDateTime()
| def FoxitPDFSDKPython2.ReadingBookmark.SetDateTime | ( | date_time, | |
| is_creation_date | |||
| ) |
设置日期时间信息。
- 参数
-
[in] date_time 新的日期时间信息。此日期对象的所有值都应有效。 更多详细信息请参考类 FoxitPDFSDKPython2.DateTime 的注释。 [in] is_creation_date true 表示设置创建日期时间信息， false 表示设置最后修改日期时间信息。
- 返回
- 无。
◆ SetPageIndex()
| def FoxitPDFSDKPython2.ReadingBookmark.SetPageIndex | ( | index | ) |
设置目标页面的索引。
- 参数
-
[in] index 新的目标页面索引。有效范围：从0到（count-1）。 count 是当前阅读书签所属PDF文档的页面数。 页面数可以通过函数 FoxitPDFSDKPython2.PDFDoc.GetPageCount 检索。
- 返回
- 无。
◆ SetTitle()
| def FoxitPDFSDKPython2.ReadingBookmark.SetTitle | ( | title | ) |
设置标题。
- 参数
-
[in] title 新的标题字符串。
- 返回
- 无。
